{-
	Copyright (c) 2009 Aitor Lopez Fadrique <mailto:aitorlf@gmail.com>
	All rights reserved
	Licensed under GNU LGPL v2.1

	$Id: GermanNorthernDeck.hs 15 2009-09-28 21:16:23Z aitorlf $

	This program is free software; you can redistribute it and/or
	modify it under the terms of the GNU Lesser General Public
	License version 2.1 (and just under that one) as published by
	the Free Software Foundation.

	This program is distributed in the hope that it will be useful,
	but without any warranty; without even the implied warranty of
	merchantability or fitness for a particular purpose. See the GNU
	Lesser General Public License for more details.

	You should have received a copy of the GNU Lesser General Public
	License along with this program; if not, write to the Free
	Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
	MA 02111-1307, USA.
-}

{-|
	Module		: Games.Cards.Deck.GermanNorthernDeck
	Copyright	: (c) Aitor Lopez Fadrique <mailto:aitorlf@gmail.com>
	License		: GNU LGPL v2.1 <http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html>

	Maintainer	: Aitor Lopez Fadrique <mailto:aitorlf@gmail.com>
	Stability	: provisional
	Portability	: portable

	Definition of the German Northern (32 cards) deck according to Games.Cards.Deck.

	This module defines the basic German 32 cards Northern deck.
-}
module Games.Cards.Deck.GermanNorthernDeck(
		-- * German 32 cards Northern deck
		-- ** Types defining cards and decks for the German Northern deck
		GermanNorthernRank(..),
		GermanSuit(..),
		GermanNorthernCard,
		GermanNorthernDeck,
		-- ** Instance of German Northern deck
		germanNorthernDeck,
	)where

import Games.Cards.Deck
import Games.Cards.Deck.GermanClassicDeck


-- | Well-known ranks for the Northern German deck.
data GermanNorthernRank =
		-- | 'VII' (/Seven 7/)
		VII
		-- | 'VIII' (/Eight 8/)
		| VIII
		-- | 'IX' (/Nine 9/)
		| IX
		-- | 'X' (/Ten 10/)
		| X
		-- | 'Under' (/Lower Jack/)
		| Under
		-- | 'Ober' (/Upper Jack/)
		| Ober
		-- | 'Konig' (/King/)
		| Konig
		-- | 'Daus' (/2/)
		| Daus
	deriving (Eq, Ord, Enum, Bounded, Show, Read)
instance CardRank GermanNorthernRank


-- | Definition of the 32 cards Northern German @'Card'@s and @'Deck'@s.

-- | German Northern card type.
type GermanNorthernCard = Card GermanNorthernRank GermanSuit WildCardNone

-- | German Northern deck type.
type GermanNorthernDeck = Deck GermanNorthernRank GermanSuit WildCardNone

-- | German Northern deck instance.
germanNorthernDeck :: GermanNorthernDeck
germanNorthernDeck = deck
